add lots of comments on the function of BuildTracker #12194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
cc @sbidoul @uranusjr @pradyunsg no rush at all; please feel free to reject this change. |
pfmoore
approved these changes
Aug 10, 2023
Co-authored-by: Paul Moore <[email protected]>
Co-authored-by: Paul Moore <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split out from #12186. It's not currently clear what the function of the
BuildTrackeris or when it needs to be used (imho). I thought that it was for managing parallel builds somehow, but it turns out it is just a validation mechanism specifically for sdists.This change is subjective and it does not need to be merged. I think that these comments + changes make the purpose of the
BuildTrackermore clear, so that future pip contributors will more easily understand when to use it.This change also modifies
AbstractDistributionwith.build_tracker_idto explicitly specify when.prepare_distribution_metadata()is going to be called, which makes the change in #12186 to cache the generated dist much easier to understand (imho).